227 workflow add checks on cpp documentation #313
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 tasks
Jelmerdw
reviewed
Oct 28, 2025
Jelmerdw
reviewed
Oct 28, 2025
Jelmerdw
reviewed
Oct 28, 2025
Jelmerdw
reviewed
Oct 28, 2025
Jelmerdw
reviewed
Oct 28, 2025
Collaborator
Jelmerdw
left a comment
Jelmerdw
left a comment
There was a problem hiding this comment.
Don't forget to sign off you commits. A DCO workflow runs automatically on all repos on alliander-opensource and fails when you don't sign off your commits.
| const moveit::core::JointModelGroup *joint_model_group; | ||
| moveit_visual_tools::MoveItVisualTools moveit_visual_tools; | ||
| PoseStamped goal_pose; | ||
| rclcpp::Node::SharedPtr node; /**< ROS2 node with MoveIt Services */ |
Collaborator
There was a problem hiding this comment.
Previously instead of using /**< ... */ I simply used // ..., is the /**< ... */ version the neater way of commenting behind a variable?
Collaborator
Author
There was a problem hiding this comment.
In order for Doxygen to recognize the comment as a docstring, it needs to be formatted a certain way. See: https://www.doxygen.nl/manual/docblocks.html
geurto
force-pushed
the
227-workflow-add-checks-on-cpp-documentation
branch
from
9cd4267 to
bcd4218
Compare
Signed-off-by: Peter Geurts <[email protected]>
Signed-off-by: Peter Geurts <[email protected]>
Signed-off-by: Peter Geurts <[email protected]>
Signed-off-by: Peter Geurts <[email protected]>
…hods; remove generated Doxygen output folder after script has run Signed-off-by: Peter Geurts <[email protected]>
…doc warnings in doxyfile.lint Signed-off-by: Peter Geurts <[email protected]>
Signed-off-by: Peter Geurts <[email protected]>
…GH workflows to use modern pip version of clang-format Signed-off-by: Peter Geurts <[email protected]>
Jelmerdw
force-pushed
the
227-workflow-add-checks-on-cpp-documentation
branch
from
bcd4218 to
224079c
Compare
Signed-off-by: Jelmer de Wolde <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds doxygen-style documentation checks for C++ code. Specifically, it adds
.cpp/.h/.hppfiles inros2_ws/src;pre-commitcheck that executes the shell script mentioned above;moveit_manager.hppto adhere to Doxygen documentation standards;Fixes: #227
Testing
pre-commitcheck with correct and incorrect documentation;actwith correct and incorrect documentation.Documentation
Additional Notes
The doxygen linter fails in
pre-commitchecks when no output is produced (theGENERATE_<...>values indoxyfile.lint). Therefore, RTF output is generated to pass the check. The generated files are added to the.gitignore.